<html>

<head>
<title>libvorbis - function - vorbis_comment_clear</title>
<link rel=stylesheet href="style.css" type="text/css">
</head>

<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
<table border=0 width=100%>
<tr>
<td><p class=tiny>libvorbis documentation</p></td>
<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td>
</tr>
</table>

<h1>vorbis_comment_clear</h1>

<p><i>declared in "vorbis/codec.h";</i></p>

<p>This function frees the internal storage associated with a <a href="vorbis_comment.html">vorbis_comment</a> structure.</p>

<p><i>Note:</i> Be careful if you have modified the vorbis_comment
structure yourself, as libvorbis will try to use its own wrappers of
memory allocation functions to free the contents of the vorbis_comment
structure.  This will not work correctly unless all arrays and comment
strings contained in the vorbis_comment structure were allocated by
libvorbis itself.  This function is only guaranteed to be safe if all
modification to the vorbis_comment structure was done using libvorbis
functions.</p>

<table border=0 color=black cellspacing=0 cellpadding=7>
<tr bgcolor=#cccccc>
	<td>
<pre><b>
extern void     vorbis_comment_clear(vorbis_comment *vc);
</b></pre>
	</td>
</tr>
</table>

<h3>Parameters</h3>
<dl>
<dt><i>vc</i></dt>
<dd>The vorbis_comment structure to clear.</dd>
</dl>


<h3>Return Values</h3>
<blockquote>
<li>None.</li>
</blockquote>
<p>

<br><br>
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
<td><p class=tiny>copyright &copy; 2010 Xiph.Org</p></td>
<td align=right><p class=tiny><a href="https://xiph.org/vorbis/">Ogg Vorbis</a></p></td>
</tr><tr>
<td><p class=tiny>libvorbis documentation</p></td>
<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td>
</tr>
</table>


</body>

</html>
